org.eclipse.vtp.framework.common.commands
Class IncludeCommand

java.lang.Object
  org.eclipse.vtp.framework.common.commands.ControllerCommand
      org.eclipse.vtp.framework.common.commands.IncludeCommand

All Implemented Interfaces:

ICommand

public final class IncludeCommand
extends ControllerCommand

A command that tells the process engine to suspend the current process and pass control to another process, resuming the current process when the target process completes.

Author:

Lonnie Pryor

Constructor Summary

IncludeCommand()
Creates a new IncludeCommand.

Method Summary

java.lang.Object	exportContents() Exports the contents of this command to a simple structure of arrays and serializable values from java.lang.
java.lang.String[]	getOutgoingDataNames(java.lang.String path)
java.lang.String	getOutgoingDataValue(java.lang.String path, java.lang.String name)
java.lang.String[]	getOutgoingPaths()
java.lang.String[]	getParameterNames() Returns the names of the parameters that will be returned from the target process.
java.lang.String[]	getParameterValues(java.lang.String name) Returns the values of a parameter to be set when the current process resumes.
java.lang.String	getTargetProcessURI() Returns the URI identifying the process to transfer control to.
java.lang.String[]	getVariableNames() Returns the names of the variables that will be passed to the target process.
java.lang.String	getVariableValue(java.lang.String targetVariableName) Returns the name of the variable in the current process that will be set as the specified variable in the target process.
void	importContents(java.lang.Object contents) Configures the contents of this command with a structure previously returned from ICommand.exportContents().
void	setOutgoingDataValue(java.lang.String path, java.lang.String name, java.lang.String value)
void	setParameterValues(java.lang.String name, java.lang.String[] values) Configures a parameter set when the current process resumes.
void	setTargetProcessURI(java.lang.String targetProcessURI) Sets the URI identifying the process to transfer control to.
void	setVariableValue(java.lang.String targetVariableName, java.lang.String localVariableName) Sets the name of the variable in the current process that will be set as the specified variable in the target process.

Methods inherited from class org.eclipse.vtp.framework.common.commands.ControllerCommand

accept

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IncludeCommand

public IncludeCommand()

Creates a new IncludeCommand.

Method Detail

getTargetProcessURI

public java.lang.String getTargetProcessURI()

Returns the URI identifying the process to transfer control to.

Returns:

The URI identifying the process to transfer control to.

setTargetProcessURI

public void setTargetProcessURI(java.lang.String targetProcessURI)

Sets the URI identifying the process to transfer control to.

Parameters:

targetProcessURI - The URI identifying the process to transfer control to.

getVariableNames

public java.lang.String[] getVariableNames()

Returns the names of the variables that will be passed to the target process.

Returns:

The names of the variables that will be passed to the target process.

getVariableValue

public java.lang.String getVariableValue(java.lang.String targetVariableName)

Returns the name of the variable in the current process that will be set as the specified variable in the target process.

Parameters:

targetVariableName - The name of the variable in the target process.

Returns:

The name of the variable in the current process that will be set as the specified variable in the target process.

setVariableValue

public void setVariableValue(java.lang.String targetVariableName,
                             java.lang.String localVariableName)

Sets the name of the variable in the current process that will be set as the specified variable in the target process.

Parameters:

targetVariableName - The name of the variable in the target process.

localVariableName - The name of the variable in the current process to pass to the target process.

getOutgoingPaths

public java.lang.String[] getOutgoingPaths()

getOutgoingDataNames

public java.lang.String[] getOutgoingDataNames(java.lang.String path)

getOutgoingDataValue

public java.lang.String getOutgoingDataValue(java.lang.String path,
                                             java.lang.String name)

setOutgoingDataValue

public void setOutgoingDataValue(java.lang.String path,
                                 java.lang.String name,
                                 java.lang.String value)

getParameterNames

public java.lang.String[] getParameterNames()

Returns the names of the parameters that will be returned from the target process.

Returns:

The names of the parameters that will be returned from the target process.

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String name)

Returns the values of a parameter to be set when the current process resumes.

Parameters:

name - The name of the parameter to be set.

Returns:

The values that specified parameter will be set to.

setParameterValues

public void setParameterValues(java.lang.String name,
                               java.lang.String[] values)

Configures a parameter set when the current process resumes.

Parameters:

name - The name of the parameter to set.

values - The values to set the parameter to.

exportContents

public java.lang.Object exportContents()

Description copied from interface: ICommand

Exports the contents of this command to a simple structure of arrays and serializable values from java.lang.

Returns:

A serializable structure this command can be re-constituted from.

importContents

public void importContents(java.lang.Object contents)

Description copied from interface: ICommand

Configures the contents of this command with a structure previously returned from ICommand.exportContents().

Parameters:

contents - The exported contents structure to load from.